GET api/SIMS/GetStockCategories?categoryCodes[0]={categoryCodes[0]}&categoryCodes[1]={categoryCodes[1]}&companyKey={companyKey}
Gets the stock category details for the category code(s) specified. If no category codes are specified, the details of all stock categories are returned.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
categoryCodes |
A list of category codes (Optional) |
Collection of string |
Required |
companyKey |
The company name if the service is connected to multiple SIMS companies (Optional) |
string |
Default value is |
Body Parameters
N/A
Response Information
Resource Description
The stock categories.
Collection of ApiStockCategoryName | Description | Type | Additional information |
---|---|---|---|
CategoryCode | string |
N/A |
|
CategoryName | string |
N/A |
|
CategoryMarkup1 | decimal number |
N/A |
|
CategoryMarkup2 | decimal number |
N/A |
|
CategoryMarkup3 | decimal number |
N/A |
|
CategoryMarkup4 | decimal number |
N/A |
|
CategoryMarkup5 | decimal number |
N/A |
|
CategoryMarkup6 | decimal number |
N/A |
|
ReplicationId | string |
N/A |
|
DepartmentCode | string |
N/A |
|
CategoryGroup | string |
N/A |
|
Colour | decimal number |
N/A |
|
Extra1 | string |
N/A |
Response Formats
application/json, text/json
Sample:
[ { "CategoryCode": "sample string 1", "CategoryName": "sample string 2", "CategoryMarkup1": 3.0, "CategoryMarkup2": 4.0, "CategoryMarkup3": 5.0, "CategoryMarkup4": 6.0, "CategoryMarkup5": 7.0, "CategoryMarkup6": 8.0, "ReplicationId": "sample string 9", "DepartmentCode": "sample string 10", "CategoryGroup": "sample string 11", "Colour": 12.0, "Extra1": "sample string 13" }, { "CategoryCode": "sample string 1", "CategoryName": "sample string 2", "CategoryMarkup1": 3.0, "CategoryMarkup2": 4.0, "CategoryMarkup3": 5.0, "CategoryMarkup4": 6.0, "CategoryMarkup5": 7.0, "CategoryMarkup6": 8.0, "ReplicationId": "sample string 9", "DepartmentCode": "sample string 10", "CategoryGroup": "sample string 11", "Colour": 12.0, "Extra1": "sample string 13" } ]